[Mailer] Document require_tls option#20701
Conversation
OskarStark
changed the title
require_tls option
mdoutreluingne
left a comment
mdoutreluingne
left a comment
There was a problem hiding this comment.
To have the same "naming" as the other versionadded directive when adding an new option
|
|
||
| This setting only works when the ``smtp://`` protocol is used. | ||
|
|
||
| Require use of TLS |
There was a problem hiding this comment.
Maybe:
| Require use of TLS | |
| Enforce TLS |
There was a problem hiding this comment.
Happy to change if preferred, but Enforce feels slightly less accurate to me. Enforce sounds like it'd change/force the connection in some manner and/or force TLS upon the whole connection process, whereas this option doesn't change the connection in any way, just ensures it's eventually used.
There was a problem hiding this comment.
I understand your concern about the term "Enforce" and I agree with you.
What do you think about "Ensure TLS" instead? It might better reflect that the option guarantees the use of TLS without actively altering the connection.
There was a problem hiding this comment.
@Spomky Sorry for the late response. I agree that "Ensure TLS" would be better. I've updated the heading to that.
javiereguiluz
force-pushed
the
mailer_document_require_tls_option
branch
from
4cb9b50 to
55217dc
Compare
|
Dan, thanks a lot for providing these docs! Sorry it took us so long to merge it. Congrats on your first Symfony Docs contribution 🎉 |
7 participants
For #20644. This PR documents the added SMTP
require_tlsoption, as introduced in symfony/symfony#59479.I have referenced that this could throw a
TransportException(where TLS is not achieved) but not sure if I should instead referenceTransportExceptionInterface.